Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Apply bestie #107

Closed
wants to merge 7 commits into from
Closed

Apply bestie #107

wants to merge 7 commits into from

Conversation

Cmurilochem
Copy link
Collaborator

@Cmurilochem Cmurilochem commented Oct 11, 2024

This is a first attempt to apply BestieTemplate.

Closes #97.

Steps to run JuliaFormatter and the pre-commit hooks

EDIT: see also https://github.com/GalerkinToolkit/GalerkinToolkit.jl/blob/apply-bestie/docs/src/91-developer.md

  1. Install pre-commit
    This can be done by installing it globally with python:
pip install pre-commit
  1. When using pre-commit, the Julia code is formatted using JuliaFormatter.jl and the information contained in .pre-commit-config.yaml, so please install it globally first:
julia> # Press ]
pkg> activate
pkg> add JuliaFormatter
  1. Install the pre-commit
    Go to the root dir of your repo and do:
pre-commit install

pre-commit will read all the info from .pre-commit-config.yaml. It gets activated so that every time you make a commit, pre-commit runs through your added code, checking its compliance with the rules.

ToDo

  • Add list of contributors
  • Link checker

@Cmurilochem Cmurilochem marked this pull request as ready for review October 18, 2024 12:12
@fverdugo fverdugo closed this Oct 18, 2024
@fverdugo fverdugo deleted the apply-bestie branch October 18, 2024 13:06
@Cmurilochem Cmurilochem mentioned this pull request Oct 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Check if there is anything in the BestieTemplate that would make sense to use here
2 participants